API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

dashboard_filters

Retrieves a dashboard_filters resource.

Retrieves a dashboard_filters resource.

Authorizations:
JWT
path Parameters
id
required
string

dashboard_filters identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "parameterName": "string",
  • "label": "string",
  • "notes": "string",
  • "entityName": "string",
  • "type": {
    },
  • "defaultValue": "string",
  • "choices": "string",
  • "required": true,
  • "source": "string",
  • "priority": 0,
  • "dataCollector": {
    },
  • "shortcode": "DF",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the dashboard_filters resource.

Replaces the dashboard_filters resource.

Authorizations:
JWT
path Parameters
id
required
string

dashboard_filters identifier

Request Body schema:
required

The updated dashboard_filters resource

parameterName
string or null

parameterName

label
string or null

label

notes
string or null
entityName
string or null
required
object (dashboard_filtertypes.jsonld-add_post)

Type.

defaultValue
string or null

defaultValue

choices
string or null

choices

Must be entered using format: key,value|key,value (...)

required
boolean
source
string or null
priority
integer
required
object (dataanalysis_datacollectors.jsonld-add_post)

DataCollector.

deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "parameterName": "string",
  • "label": "string",
  • "notes": "string",
  • "entityName": "string",
  • "type": {
    },
  • "defaultValue": "string",
  • "choices": "string",
  • "required": true,
  • "source": "string",
  • "priority": 0,
  • "dataCollector": {
    },
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "parameterName": "string",
  • "label": "string",
  • "notes": "string",
  • "entityName": "string",
  • "type": {
    },
  • "defaultValue": "string",
  • "choices": "string",
  • "required": true,
  • "source": "string",
  • "priority": 0,
  • "dataCollector": {
    },
  • "shortcode": "DF",
  • "id": 0,
  • "slug": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uniqueId": "string",
  • "taggingListing": "string"
}

Removes the dashboard_filters resource.

Removes the dashboard_filters resource.

Authorizations:
JWT
path Parameters
id
required
string

dashboard_filters identifier

Responses